Skip to content

docs: format README code blocks for ruff 0.16 - #98

Merged
Daniel Willim (kognic-willim) merged 1 commit into
masterfrom
fix-readme-ruff-format
Aug 18, 2026
Merged

docs: format README code blocks for ruff 0.16#98
Daniel Willim (kognic-willim) merged 1 commit into
masterfrom
fix-readme-ruff-format

Conversation

@kognic-willim

@kognic-willim Daniel Willim (kognic-willim) commented Aug 18, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Contributor

Master CI's lint job fails because the unpinned ruff-action picked up ruff 0.16, which now formats Python code blocks inside markdown files. This reformats the README's examples (two blank lines around top-level definitions) so ruff format --check passes again.

Whitespace-only change; verified ruff format --check . and ruff check . pass with ruff 0.16.3.

Summary by CodeRabbit

  • Documentation
    • Improved readability of synchronous client, asynchronous client, and Pydantic model examples by adding spacing.
    • No functional behavior or public API changes.

@coderabbitai

coderabbitai Bot commented Aug 18, 2026 •
edited
Loading

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 1cc31d4a-6889-4231-a1a8-e977e7db6fda

📥 Commits

Reviewing files that changed from the base of the PR and between 25704fc and 044b906.

📒 Files selected for processing (1)
  • README.md

Included review availability: Your plan includes up to 3 reviews per rolling hour; 2 remain after this review.

📝 Walkthrough

Walkthrough

The README now has additional blank lines in the synchronous client, asynchronous client, and Pydantic model examples. No code behavior or public declarations changed.

Changes

README example formatting

Layer / File(s) Summary
Example spacing
README.md		 Added blank lines around the MyApiClient, MyAsyncApiClient, and CreateRequest examples. The example code remains unchanged.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 044b9

This is a localized README whitespace-only change that restores formatting-tool compatibility; no actionable merge-blocking risk remains after normal checks and review.

Suggested reviewers: jonaslohsekog

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the README formatting changes required for Ruff 0.16.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix-readme-ruff-format
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch fix-readme-ruff-format

Comment @coderabbitai help to get the list of available commands.

@kognic-willim
Daniel Willim (kognic-willim) marked this pull request as ready for review August 18, 2026 11:11
@kognic-willim
Daniel Willim (kognic-willim) requested a review from a team as a code owner August 18, 2026 11:11
@kognic-willim
Daniel Willim (kognic-willim) merged commit 1610dc9 into master Aug 18, 2026
12 checks passed
@kognic-willim
Daniel Willim (kognic-willim) deleted the fix-readme-ruff-format branch August 18, 2026 11:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kallus Jonatan Kallus (kallus) kallus approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@kognic-willim @kallus